Koala Plot Core/io.github.koalaplot.core.legend

Package-level declarations

Types

LegendLocation

enum LegendLocation : Enum<LegendLocation>

Identifies the location at which to place a chart's legend.

LegendScope

interface LegendScope

Scope for the children of a ColumnLegend or GridLegend.

Functions

ColumnLegend

@Composable

fun ~~ColumnLegend~~(itemCount: Int, symbol: @Composable LegendScope.(item: Int) -> Unit = {}, label: @Composable LegendScope.(item: Int) -> Unit = {}, value: @Composable LegendScope.(item: Int) -> Unit = {}, rowGap: Dp = KoalaPlotTheme.sizes.gap, columnGap: Dp = KoalaPlotTheme.sizes.gap, modifier: Modifier = Modifier)

Creates a legend with itemCount legend items laid out vertically in a column. Each row of the legend consists of a symbol, label, and value.

ColumnLegend2

@Composable

fun ColumnLegend2(itemCount: Int, modifier: Modifier = Modifier, symbol: @Composable LegendScope.(item: Int) -> Unit = {}, label: @Composable LegendScope.(item: Int) -> Unit = {}, value: @Composable LegendScope.(item: Int) -> Unit = {}, rowGap: Dp = KoalaPlotTheme.sizes.gap, columnGap: Dp = KoalaPlotTheme.sizes.gap)

Creates a legend with itemCount legend items laid out vertically in a column. Each row of the legend consists of a symbol, label, and value.

FlowLegend

@Composable

fun ~~FlowLegend~~(itemCount: Int, symbol: @Composable LegendScope.(item: Int) -> Unit = {}, label: @Composable LegendScope.(item: Int) -> Unit = {}, symbolGap: Dp = KoalaPlotTheme.sizes.gap, columnGap: Dp = KoalaPlotTheme.sizes.gap, rowGap: Dp = KoalaPlotTheme.sizes.gap, modifier: Modifier = Modifier)

A flow layout type of legend where each entry will take as much horizontal space as it requires, up to the maximum width of the component. Multiple legend entries will be placed in the same row until all horizontal space is consumed.

FlowLegend2

@Composable

fun FlowLegend2(itemCount: Int, modifier: Modifier = Modifier, symbol: @Composable LegendScope.(item: Int) -> Unit = {}, label: @Composable LegendScope.(item: Int) -> Unit = {}, symbolGap: Dp = KoalaPlotTheme.sizes.gap, columnGap: Dp = KoalaPlotTheme.sizes.gap, rowGap: Dp = KoalaPlotTheme.sizes.gap)